Retrieve Wallet Options

Request to retrieve information from the payer's wallet before the checkout page is presented so that you can streamline the checkout process. For example, the wallet may return details about the payer's shipping address and masked card numbers that you can use to display on checkout pages.

For the MasterPass wallet, provide the Long Access Token for a paired wallet to retrieve information about that wallet.

For more information on pairing see - MasterPass Pairing

POST https://anzworldline.gateway.mastercard.com/api/nvp/version/57

Authentication Copied to clipboard

This operation requires authentication via one of the following methods:


  • Certificate authentication.
  • To authenticate to the API two additional NVP parameters must be supplied in the request. Provide 'merchant.<your gateway merchant ID>' in the apiUsername field and your API password in the apiPassword field.

Request Copied to clipboard

Fields Copied to clipboard

apiOperation Copied to clipboard String = RETRIEVE_WALLET_OPTIONS FIXED

Any sequence of zero or more unicode characters.

correlationId Copied to clipboard String OPTIONAL

A transient identifier for the request, that can be used to match the response to the request.

The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.

Data can consist of any characters

Min length: 1 Max length: 100
merchant Copied to clipboard Alphanumeric + additional characters REQUIRED

The unique identifier issued to you by your payment provider.

This identifier can be up to 12 characters in length.

Data may consist of the characters 0-9, a-z, A-Z, '-', '_'

Min length: 1 Max length: 40
order Copied to clipboard REQUIRED

order

order.walletProvider Copied to clipboard Enumeration REQUIRED

Select the wallet provider for this interaction.

Value must be a member of the following list. The values are case sensitive.

AMEX_EXPRESS_CHECKOUT

Amex Express Checkout wallet provider.

APPLE_PAY

Apple Pay mobile wallet provider.

GOOGLE_PAY

Google Pay mobile wallet provider.

MASTERPASS_ONLINE

MasterPass Online wallet provider.

VISA_CHECKOUT

Visa Checkout wallet provider.

wallet.masterpass.longAccessToken Copied to clipboard String REQUIRED

A wallet token provided by the gateway for Masterpass paired accounts.

Save this token and use it in the Retrieve Wallet Options request to obtain pre-checkout data from the payer's wallet for future interactions.

Data can consist of any characters

Min length: 1 Max length: 255

Response Copied to clipboard

Fields Copied to clipboard

correlationId Copied to clipboard String CONDITIONAL

A transient identifier for the request, that can be used to match the response to the request.

The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.

Data can consist of any characters

Min length: 1 Max length: 100
merchant Copied to clipboard Alphanumeric + additional characters ALWAYS PROVIDED

The unique identifier issued to you by your payment provider.

This identifier can be up to 12 characters in length.

Data may consist of the characters 0-9, a-z, A-Z, '-', '_'

Min length: 1 Max length: 40
result Copied to clipboard Enumeration ALWAYS PROVIDED

A system-generated high level overall result of the operation.

Value must be a member of the following list. The values are case sensitive.

ERROR

ERROR

SUCCESS

SUCCESS

wallet.masterpass Copied to clipboard CONDITIONAL

Details of the MasterPass wallet.

wallet.masterpass.longAccessToken Copied to clipboard String CONDITIONAL

A wallet token provided by the gateway for Masterpass paired accounts.

Provide this token to obtain pre-checkout data from the payer's wallet for future interactions.

Data can consist of any characters

Min length: 1 Max length: 255
wallet.masterpass.masterpassLogoUrl Copied to clipboard Url CONDITIONAL

The Url for the MasterPass logo.

Display the image near the pre-checkout data in order to comply with MasterPass branding requirements.

Ensure that the URL begins with 'https' and is longer than 11 characters.

wallet.masterpass.precheckoutData Copied to clipboard CONDITIONAL

Information obtained from the payer's paired wallet.

Present this pre-checkout data to the payer during the checkout process to streamline the MasterPass interaction.

wallet.masterpass.precheckoutData.billing.address.country Copied to clipboard String CONDITIONAL

The 3 letter ISO standard alpha country code of the payer's address.

Data can consist of any characters

Min length: 3 Max length: 3
wallet.masterpass.precheckoutData.card[n] Copied to clipboard CONDITIONAL

Information about the cards in the payer's MasterPass wallet.

Present these cards to the payer during the checkout process so they may choose which card to pay with.

wallet.masterpass.precheckoutData.card[n].alias Copied to clipboard String CONDITIONAL

The name the payer gave to the card.

Display this to the payer along with the card data, so they know which card they are selecting.

Data can consist of any characters

Min length: 1 Max length: 50
wallet.masterpass.precheckoutData.card[n].brand Copied to clipboard Enumeration CONDITIONAL

The brand name used to describe the card that is recognized and accepted globally.

Value must be a member of the following list. The values are case sensitive.

AMEX

American Express

CHINA_UNIONPAY

China UnionPay

JCB

JCB (Japan Credit Bureau)

LOCAL_BRAND_ONLY

The card does not have a global brand.

MASTERCARD

MasterCard

UATP

UATP (Universal Air Travel Plan)

UNKNOWN

The brand of the card used in the transaction could not be identified

VISA

Visa

wallet.masterpass.precheckoutData.card[n].default Copied to clipboard Boolean CONDITIONAL

The payer-preferred card for payment.

If this value is TRUE, present this card as selected by default.

The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)

wallet.masterpass.precheckoutData.card[n].expiry Copied to clipboard CONDITIONAL

Expiry date, as shown on the card.

wallet.masterpass.precheckoutData.card[n].expiry.month Copied to clipboard Digits CONDITIONAL

Month, as shown on the card.

Months are numbered January=1, through to December=12.

Data is a number between 1 and 12 represented as a string.

wallet.masterpass.precheckoutData.card[n].expiry.year Copied to clipboard Digits CONDITIONAL

Year, as shown on the card.

The Common Era year is 2000 plus this value.

Data is a string that consists of the characters 0-9.

Min length: 2 Max length: 2
wallet.masterpass.precheckoutData.card[n].masterpassCardId Copied to clipboard String CONDITIONAL

The MasterPass identifier for the card.

Provide this value to MasterPass in the cardId parameter when you initiate a 'Connected Checkout' or 'Express Checkout' MasterPass interaction for this wallet.

Data can consist of any characters

Min length: 1 Max length: 255
wallet.masterpass.precheckoutData.card[n].nameOnCard Copied to clipboard String CONDITIONAL

The cardholder's name as printed on the card.

Data can consist of any characters

Min length: 1 Max length: 255
wallet.masterpass.precheckoutData.card[n].number Copied to clipboard String CONDITIONAL

The masked card number.

Data can consist of any characters

Min length: 1 Max length: 20
wallet.masterpass.precheckoutData.consumerWalletId Copied to clipboard String CONDITIONAL

The MasterPass identifier for the payer's wallet.

Provide this value to MasterPass when you initiate a 'Connected Checkout' or 'Express Checkout' interaction for this wallet.

Data can consist of any characters

Min length: 1 Max length: 50
wallet.masterpass.precheckoutData.customer.email Copied to clipboard String CONDITIONAL

The payer's email address.

Data can consist of any characters

Min length: 1 Max length: 255
wallet.masterpass.precheckoutData.customer.firstName Copied to clipboard String CONDITIONAL

The payer's first name.

Data can consist of any characters

Min length: 1 Max length: 255
wallet.masterpass.precheckoutData.customer.lastName Copied to clipboard String CONDITIONAL

The payer's last name or surname.

Data can consist of any characters

Min length: 1 Max length: 255
wallet.masterpass.precheckoutData.customer.phone Copied to clipboard String CONDITIONAL

The payer's telephone number.

Data can consist of any characters

Min length: 1 Max length: 255
wallet.masterpass.precheckoutData.precheckoutTransactionId Copied to clipboard String CONDITIONAL

A MasterPass transaction identifier.

Provide this value to MasterPass when you initiate a 'Connected Checkout' or 'Express Checkout' MasterPass interaction for this wallet.

Data can consist of any characters

Min length: 1 Max length: 50
wallet.masterpass.precheckoutData.shippingAddress[n] Copied to clipboard CONDITIONAL

Information about the shipping addresses contained in the payer's MasterPass wallet.

Present these shipping addresses to the payer during the checkout process to streamline the MasterPass interaction.

wallet.masterpass.precheckoutData.shippingAddress[n].address Copied to clipboard CONDITIONAL

Address to ship the goods to.

wallet.masterpass.precheckoutData.shippingAddress[n].address.alias Copied to clipboard String CONDITIONAL

The name the payer gave to the shipping address.

Display this to the payer along with the shipping address data, so they know which shipping address they are selecting.

Data can consist of any characters

Min length: 1 Max length: 255
wallet.masterpass.precheckoutData.shippingAddress[n].address.city Copied to clipboard String CONDITIONAL

The city portion of the shipping address.

Data can consist of any characters

Min length: 1 Max length: 255
wallet.masterpass.precheckoutData.shippingAddress[n].address.country Copied to clipboard String CONDITIONAL

The 3 letter ISO standard alpha country code of the shipping address.

Data can consist of any characters

Min length: 3 Max length: 3
wallet.masterpass.precheckoutData.shippingAddress[n].address.default Copied to clipboard Boolean CONDITIONAL

The payer-preferred shipping address for payment.

If this value is TRUE, present this shipping address as the initially-selected one.

The values 'true' or 'false'. (For a complete description, see http://www.w3.org/TR/xmlschema-2/#boolean.)

wallet.masterpass.precheckoutData.shippingAddress[n].address.masterpassShippingId Copied to clipboard String CONDITIONAL

The MasterPass identifier for the shipping address.

Provide this value to MasterPass in the shippingId parameter when you initiate a 'Connected Checkout' or 'Express Checkout' MasterPass interaction for this wallet.

Data can consist of any characters

Min length: 1 Max length: 255
wallet.masterpass.precheckoutData.shippingAddress[n].address.postcodeZip Copied to clipboard String CONDITIONAL

The post code or zip code of the shipping address.

Data can consist of any characters

Min length: 1 Max length: 255
wallet.masterpass.precheckoutData.shippingAddress[n].address.stateProvince Copied to clipboard String CONDITIONAL

The state or province of the shipping address.

Data can consist of any characters

Min length: 1 Max length: 255
wallet.masterpass.precheckoutData.shippingAddress[n].address.street Copied to clipboard String CONDITIONAL

The first line of the address.

For example, this may be the street name and number, or the Post Office Box details.

Data can consist of any characters

Min length: 1 Max length: 255
wallet.masterpass.precheckoutData.shippingAddress[n].address.street2 Copied to clipboard String CONDITIONAL

The second line of the address (if provided).

Data can consist of any characters

Min length: 1 Max length: 255
wallet.masterpass.precheckoutData.shippingAddress[n].contact Copied to clipboard CONDITIONAL

The contact details for the person residing at this address.

wallet.masterpass.precheckoutData.shippingAddress[n].contact.firstName Copied to clipboard String CONDITIONAL

The first name of the person the goods are being shipped to.

Data can consist of any characters

Min length: 1 Max length: 255
wallet.masterpass.precheckoutData.shippingAddress[n].contact.lastName Copied to clipboard String CONDITIONAL

The last name or surname of the person the goods are being shipped to.

Data can consist of any characters

Min length: 1 Max length: 255
wallet.masterpass.precheckoutData.shippingAddress[n].contact.phone Copied to clipboard String CONDITIONAL

The telephone number of the person the goods are being shipped to.

Data can consist of any characters

Min length: 1 Max length: 255
wallet.masterpass.precheckoutData.walletName Copied to clipboard String CONDITIONAL

The name the payer has assigned to their MasterPass wallet.

Display this name to the payer during the checkout process, so they know which wallet is being used for the payment interaction.

Data can consist of any characters

Min length: 1 Max length: 50
wallet.masterpass.walletPartnerLogoUrl Copied to clipboard Url CONDITIONAL

The Url for the Wallet partner logo.

Display the image near the pre-checkout data in order to comply with MasterPass branding requirements.

Ensure that the URL begins with 'https' and is longer than 11 characters.

Errors Copied to clipboard

error Copied to clipboard

Information on possible error conditions that may occur while processing an operation using the API.

error.cause Copied to clipboard Enumeration

Broadly categorizes the cause of the error.

For example, errors may occur due to invalid requests or internal system failures.

Value must be a member of the following list. The values are case sensitive.

INVALID_REQUEST

The request was rejected because it did not conform to the API protocol.

REQUEST_REJECTED

The request was rejected due to security reasons such as firewall rules, expired certificate, etc.

SERVER_BUSY

The server did not have enough resources to process the request at the moment.

SERVER_FAILED

There was an internal system failure.

error.explanation Copied to clipboard String

Textual description of the error based on the cause.

This field is returned only if the cause is INVALID_REQUEST or SERVER_BUSY.

Data can consist of any characters

Min length: 1 Max length: 1000
error.field Copied to clipboard String

Indicates the name of the field that failed validation.

This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.

Data can consist of any characters

Min length: 1 Max length: 100
error.supportCode Copied to clipboard String

Indicates the code that helps the support team to quickly identify the exact cause of the error.

This field is returned only if the cause is SERVER_FAILED or REQUEST_REJECTED.

Data can consist of any characters

Min length: 1 Max length: 100
error.validationType Copied to clipboard Enumeration

Indicates the type of field validation error.

This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.

Value must be a member of the following list. The values are case sensitive.

INVALID

The request contained a field with a value that did not pass validation.

MISSING

The request was missing a mandatory field.

UNSUPPORTED

The request contained a field that is unsupported.

result Copied to clipboard Enumeration

A system-generated high level overall result of the operation.

Value must be a member of the following list. The values are case sensitive.

ERROR

The operation resulted in an error and hence cannot be processed.